Automation Setup with API
Overview
In some cases, you may want to add contacts that exist in your back-office system. Kore Commerce supports this through its API, which allows for bi-directional integration between your back-office ERP and your site.
This page covers the basic concepts of importing contacts into your Kore site via Kore Commerce’s API. To learn more about the Kore Commerce import API system, you can visit the Inbound Integration to Kore Commerce page of this guide. You can also view the KS_Contacts page to see the fields used when importing contact and user information.
Importing Contacts and Automatically Creating Linked User Accounts
In order to properly integrate between your back-office system and Kore Commerce, you must have a CLEAN source of contacts in your back-office system. This means that there are a few required and unique fields that must be present for each contact being integrated into your Kore Commercesystem:
Required:
-
Contact Name
-
Contact Email
Unique:
-
Company Number
Each of these fields are listed on the KS_Contacts page of this guide.
As well, if you want to automatically create a linked user account for each contact you are importing, you can control automatic user creation via the Auto Set Web Access Code. The Auto Set Web Access Code is listed on the KS_Contacts page, and is used for creating and enabling (or disabling/removing) user access for imported contacts.
When using the Auto Set Web Access Code, there are three options:
Activate:
-
The API will create a user account (via the contact’s email) and generate a password ONLY if a web account does not exist. An email will automatically be sent out to the user that welcomes them to the site and invites them to set their password. You can learn how to customize these automatic emails in the Notification Template section of this guide.
-
If a web account already exists, this code will only ensure that the account is active (has web access).
Deactivate:
-
If a user account exists, the password will be preserved, but web access will be denied. This makes it so when a user attempts to login to their account, your site will notify them that their account has been disabled.
-
Selecting deactivate is useful for blocking contacts from accessing their account. This is especially relevant if your site allows self-registration.
Remove:
-
If a web account exists, it will be removed entirely. This means that a user will have to recreate an account. Since the contact and user are being deleted from your site, a contact will be able to recreate their account using the same email.
Once an import is complete, the contacts (and any linked users) will be visible on your Kore Commerce site.
Other Relevant Information
It is important to note that your back-office system must have some way of indicating that a given contact should be given web access on your site. Without this, this option will not function.
Another important note is that Kore Commerce does not allow you to set passwords in the back-office, then transfer these passwords into Kore Commerce. All you can do is activate, deactivate, and remove web access. The users created after the import will be in charge of establishing a password that is private to them.
Related Pages